VIVE 3DSP Native C Library  ver 1.0.0.0
Audio 3DSP (3D Sound Perception) Native C Library
Data Structures | Typedefs | Enumerations
HTC_Vive3DSP_SDK Namespace Reference

Data Structures

struct  VIVE_3DSP_OCCLUSION_PROPERTY
 
struct  VIVE_3DSP_Quaternion
 
struct  VIVE_3DSP_ROOM_PROPERTY
 
struct  VIVE_3DSP_TransformData
 
struct  VIVE_3DSP_Vector3
 
struct  VIVE_3DSP_Version
 

Typedefs

typedef struct vive_3dsp_context_ vive_3dsp_context
 
typedef int VIVE_3DSP_OCCLUSION_CHANNEL_ID
 
typedef struct vive_3dsp_internal_room_ vive_3dsp_room
 
typedef struct vive_3dsp_internal_occlusion_object vive_3dsp_occlusion
 
typedef struct vive_3dsp_internal_source vive_3dsp_audiosource
 
typedef struct vive_3dsp_internal_doppler_source vive_3dsp_dopplersource
 
typedef struct vive_3dsp_ambi_decoder vive_3dsp_ambisonic_decoder
 

Enumerations

enum  VIVE_3DSP_API_STATUS {
  Status_Success = 0, Status_Error = -1, Status_SampleRate_Not_Support = -2, Status_Source_Not_Found = -3,
  Status_Occlusion_Not_Found = -4, Status_Room_Not_Found = -5
}
 
enum  VIVE_3DSP_CHANNELTYPE { CHANNELTYPE_MONO = 0, CHANNELTYPE_STEREO }
 
enum  VIVE_3DSP_REVERB_MATERIAL {
  REVERB_NONE = 0, REVERB_CONCRETE, REVERB_CARPET, REVERB_WOOD,
  REVERB_GLASS, REVERB_COARSE_CONCRETE, REVERB_CURTAIN, REVERB_FIBER_GLASS,
  REVERB_FOAM, REVERB_SHEETROCK, REVERB_PLYWOOD, REVERB_PLASTER,
  REVERB_BRICK, REVERB_USERDEFINED
}
 
enum  VIVE_3DSP_ROOM_REVERB_PRESET {
  ROOM_GENERIC = 0, ROOM_BATHROOM, ROOM_LIVINGROOM, ROOM_CHURCH,
  ROOM_ARENA, ROOM_USERDEFINED
}
 
enum  VIVE_3DSP_ROOM_PLANE {
  ROOM_FLOOR = 0, ROOM_CEILING, ROOM_LEFTWALL, ROOM_RIGHTWALL,
  ROOM_FRONTWALL, ROOM_BACKWALL
}
 
enum  VIVE_3DSP_REVERB_MODEL { REVERB_MONO = 0, REVERB_BINAURAL }
 
enum  VIVE_3DSP_BINAURAL_REVERB_ENGINE { BINAURAL_ENGINE_SPEEDUP = 0, BINAURAL_ENGINE_NORMAL }
 
enum  VIVE_3DSP_OCC_MATERIAL {
  OCC_CURTAIN = 0, OCC_THIN_DOOR, OCC_WOOD_WALL, OCC_WINDOW,
  OCC_HARDWOOD_DOOR, OCC_WINDOW_SEPARATE, OCC_HOLLOW_CINDER_CONCRETE_WALL, OCC_SINGAL_LEAF_BRICK_WALL,
  OCC_METAL_DOOR, OCC_STONE_WALL, OCC_USER_DEFINED
}
 
enum  VIVE_3DSP_HEADSET_MODEL { HEADSET_NONE = 0, HEADSET_HTC_VIVE_PRO }
 
enum  VIVE_3DSP_OCCLUSION_ENGINE { BasicOcclusion = 0, AdvancedOcclusion, RaycastOcclusion }
 
enum  VIVE_3DSP_OCCLUSION_COMPUTE_ENGINE { ExtremelyLightWeight = 0, Simple, Normal, Detail }
 
enum  RoomBackgroundAudioType {
  BG_None = 0, BG_BigRoom, BG_SmallRoom, BG_AirConditioner,
  BG_Refrigerator, BG_PinkNoise, BG_BrownNoise, BG_WhiteNoise,
  BG_Preserved, BG_NUM
}
 
enum  VIVE_3DSP_DISTANCE_MODE {
  VIVE_3DSP_DISTANCE_REALWORLD = 0, VIVE_3DSP_DISTANCE_POINT_SOURCE, VIVE_3DSP_DISTANCE_LINE_SOURCE, VIVE_3DSP_DISTANCE_LINEAR,
  VIVE_3DSP_DISTANCE_CONSTANT
}
 

Typedef Documentation

◆ vive_3dsp_ambisonic_decoder

typedef struct vive_3dsp_ambi_decoder HTC_Vive3DSP_SDK::vive_3dsp_ambisonic_decoder

◆ vive_3dsp_audiosource

typedef struct vive_3dsp_internal_source HTC_Vive3DSP_SDK::vive_3dsp_audiosource

◆ vive_3dsp_context

typedef struct vive_3dsp_context_ HTC_Vive3DSP_SDK::vive_3dsp_context

◆ vive_3dsp_dopplersource

typedef struct vive_3dsp_internal_doppler_source HTC_Vive3DSP_SDK::vive_3dsp_dopplersource

◆ vive_3dsp_occlusion

typedef struct vive_3dsp_internal_occlusion_object HTC_Vive3DSP_SDK::vive_3dsp_occlusion

◆ VIVE_3DSP_OCCLUSION_CHANNEL_ID

Define occlusion channel ID.

◆ vive_3dsp_room

typedef struct vive_3dsp_internal_room_ HTC_Vive3DSP_SDK::vive_3dsp_room

Enumeration Type Documentation

◆ RoomBackgroundAudioType

Background audio presets.

Enumerator
BG_None 

None.

BG_BigRoom 

The background noise in a big room.

BG_SmallRoom 

The background noise in a small room.

BG_AirConditioner 

The background noise of an air conditioner.

BG_Refrigerator 

The background noise of a refrigerator.

BG_PinkNoise 

The pink noise.

BG_BrownNoise 

The brown noise.

BG_WhiteNoise 

The white noise.

BG_Preserved 

Preserved.

BG_NUM 

The number of presets.

◆ VIVE_3DSP_API_STATUS

Global status definition of VIVE 3DSP API.

Enumerator
Status_Success 

The function is successfully done.

Status_Error 

The operation failed. This is a generic error, returned if the library cannot return a more specific error.

Status_SampleRate_Not_Support 

The sample rate argument is not supported. This SDK currently supports 22050, 44100, 88200, 96000, and 192000 Hz.

Status_Source_Not_Found 

The source object does not exist when calling this operation. Make sure that you get the source object from vive_3dsp_source_create_object.

Status_Occlusion_Not_Found 

The occlusion object does not exist when calling this operation. Make sure that you get this object from vive_3dsp_occlusion_create_object.

Status_Room_Not_Found 

The room object does not exist when calling this operation. Make sure that you get this object from vive_3dsp_room_create_object.

◆ VIVE_3DSP_BINAURAL_REVERB_ENGINE

Room Binaural Reverb engine.

Enumerator
BINAURAL_ENGINE_SPEEDUP 

The simple room binaural reverb.

BINAURAL_ENGINE_NORMAL 

The advanced room binaural reverb.

◆ VIVE_3DSP_CHANNELTYPE

Supported audio channel type.

Enumerator
CHANNELTYPE_MONO 

A single speaker, typically in front of the user.

CHANNELTYPE_STEREO 

A pair of speakers, one to the left of the user, and one to the right. This is also the setting to use when playing audio over headphones.

◆ VIVE_3DSP_DISTANCE_MODE

Distance mode of the audio source.

Enumerator
VIVE_3DSP_DISTANCE_REALWORLD 

Sound decay of real-world measurement.

VIVE_3DSP_DISTANCE_POINT_SOURCE 

Sound decay of dot shaped source.

VIVE_3DSP_DISTANCE_LINE_SOURCE 

Sound decay of line shaped source.

VIVE_3DSP_DISTANCE_LINEAR 

Sound decay of scalar linear decrease.

VIVE_3DSP_DISTANCE_CONSTANT 

No decay.

◆ VIVE_3DSP_HEADSET_MODEL

Headset compensation mode.

Enumerator
HEADSET_NONE 

No compensation.

HEADSET_HTC_VIVE_PRO 

Specific compensation for HTC VIVE Pro.

◆ VIVE_3DSP_OCC_MATERIAL

Occlusion and obstruction transmission presets.

Enumerator
OCC_CURTAIN 

Curtain.

OCC_THIN_DOOR 

Door, flush panel, hollow core, normal cracks.

OCC_WOOD_WALL 

Chipboard sheet on wood.

OCC_WINDOW 

Signal glass window.

OCC_HARDWOOD_DOOR 

Hardwood door.

OCC_WINDOW_SEPARATE 

Panes in separate frames, 50mm cavity.

OCC_HOLLOW_CINDER_CONCRETE_WALL 

Hollow cinder concrete blocks.

OCC_SINGAL_LEAF_BRICK_WALL 

Single leaf brick, plastered both sides.

OCC_METAL_DOOR 

Metal door; damped skins, absorbent core, gasketing.

OCC_STONE_WALL 

Stone wall.

OCC_USER_DEFINED 

User-defined material.

◆ VIVE_3DSP_OCCLUSION_COMPUTE_ENGINE

Occlusion physical compute mode.

Enumerator
ExtremelyLightWeight 

An extremely light-weighted occlusion engine. Use one ray for cover ratio calculation.

Simple 

A simple light-weighted occlusion engine. Use five rays for cover ratio calculation.

Normal 

A middle light-weighted occlusion engine. Use ten rays for cover ratio calculation.

Detail 

A complex occlusion engine. Use project method for cover ratio calculation.

◆ VIVE_3DSP_OCCLUSION_ENGINE

Occlusion physical engine.

Enumerator
BasicOcclusion 

A light-weighted occlusion engine. It is suitable for sphere-like occlusion object.

AdvancedOcclusion 

An engine for box-like occlusion object.

RaycastOcclusion 

User-defined engine. On this mode, users need to specify cover ratio by vive_3dsp_occlusion_set_cover_ratio or vive_3dsp_occlusion_set_channel_cover_ratio.

◆ VIVE_3DSP_REVERB_MATERIAL

The acoustic properties of a surface. For now you can specify the acoustic material properties of a room. It will give different amounts of the reflection of the surface.

Enumerator
REVERB_NONE 

The surface performs the ideal reflection.

REVERB_CONCRETE 

Concrete material.

REVERB_CARPET 

Carpet material.

REVERB_WOOD 

Wood material.

REVERB_GLASS 

Glass material.

REVERB_COARSE_CONCRETE 

Coarse concrete material.

REVERB_CURTAIN 

Curtain material.

REVERB_FIBER_GLASS 

Fiber glass material.

REVERB_FOAM 

Foam material.

REVERB_SHEETROCK 

Sheetrock material.

REVERB_PLYWOOD 

Plywood material.

REVERB_PLASTER 

Plaster material.

REVERB_BRICK 

Brick material.

REVERB_USERDEFINED 

User-defined reflection rate.

◆ VIVE_3DSP_REVERB_MODEL

Room Reverb model.

Enumerator
REVERB_MONO 

The simple room reverb.

REVERB_BINAURAL 

The binaural room reverb.

◆ VIVE_3DSP_ROOM_PLANE

Surfaces of a room.

Enumerator
ROOM_FLOOR 

The floor.

ROOM_CEILING 

The ceiling.

ROOM_LEFTWALL 

The left wall.

ROOM_RIGHTWALL 

The right wall.

ROOM_FRONTWALL 

The front wall.

ROOM_BACKWALL 

The back wall.

◆ VIVE_3DSP_ROOM_REVERB_PRESET

Preset of a room reverb.

Enumerator
ROOM_GENERIC 

The general room reverb.

ROOM_BATHROOM 

Bath room.

ROOM_LIVINGROOM 

Living room.

ROOM_CHURCH 

Church.

ROOM_ARENA 

Arena.

ROOM_USERDEFINED 

Preserved.